IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks.aware/CustomIntelliJPlatformVersionAware

CustomIntelliJPlatformVersionAware

interface CustomIntelliJPlatformVersionAware : IntelliJPlatformVersionAware

By default, the project with the IntelliJ Platform Gradle Plugin applied required the presence of the IntelliJ Platform, referred to later by various tasks, configurations, and extensions. The Custom IntelliJ Platform concept allows using another version, i.e., to run a guest IDE or tests against it. When applying this interface to the task, custom configurations to hold new dependencies defined by type and version (or localPath, if referring to the local IntelliJ Platform instance) are created, as well as a dedicated PrepareSandboxTask task. Configurations, as well as the task preparing sandbox for running and testing the custom IntelliJ Platform (if required), have a random suffix applied to avoid collisions.

Inheritors

Properties

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val localPath: DirectoryProperty

An input property to define the path to the local IntelliJ Platform instance to configure the version of the custom IntelliJ Platform. The local path precedes the IntelliJ Platform resolution using the type and version properties.

Link copied to clipboard
@get:Internal
open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

Link copied to clipboard
@get:Internal
open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

Link copied to clipboard
@get:Input
@get:Optional
abstract val type: Property<IntelliJPlatformType>

An input property to configure the type of the custom IntelliJ Platform.

Link copied to clipboard
@get:Input
@get:Optional
abstract val version: Property<String>

An input property to configure the version of the custom IntelliJ Platform.

Functions

Link copied to clipboard
open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.